package apidocs;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 返回数据的字段描述
 * Created by zhangzc on 2/17/17.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface ApiResultField {

    /**
     * 中文描述
     * @return
     */
    String value();

    /**
     * 备注，一般描述格式类型、数值含义等
     * @return
     */
    String note() default "";

    /**
     * 渲染类型
     * @return
     */
    RenderEnum render() default RenderEnum.Raw;

    /**
     * 是否能导出
     * @return
     */
    boolean canExport() default true;

    /**
     * 导出标题，如果不填则使用value()
     * @return
     */
    String exportTitle() default "";

    /**
     * 导出顺序，越小越靠前
     * @return
     */
    int exportOrder() default 0;

    /**
     * 如果是枚举类型，可以在此指定
     */
    Class<? extends Enum> enumType() default NotEnum.class;
}
